<!DOCTYPE html>
<html>
    <head>
        <meta http-equiv="Content-Type" content="text/html; charset=utf-8" />
        <title>iRedMail Easy: Getting started</title>
        <link rel="stylesheet" type="text/css" href="./css/markdown.css" />
    </head>
    <body>

    <div id="navigation">
    <a href="https://www.iredmail.org" target="_blank">
        <img alt="iRedMail web site"
             src="./images/logo-iredmail.png"
             style="vertical-align: middle; height: 30px;"
             />&nbsp;
        <span>iRedMail</span>
    </a>
    &nbsp;&nbsp;//&nbsp;&nbsp;<a href="./index.html">Document Index</a></div><h1 id="iredmail-easy-getting-started">iRedMail Easy: Getting started</h1>
<div class="admonition attention">
<p class="admonition-title">Attention</p>
<p>Check out the lightweight on-premises email archiving software developed by iRedMail team: <a href="https://spiderd.io/">Spider Email Archiver</a>.</p>
</div>
<div class="toc">
<ul>
<li><a href="#iredmail-easy-getting-started">iRedMail Easy: Getting started</a><ul>
<li><a href="#summary">Summary</a></li>
<li><a href="#system-requirements">System Requirements</a><ul>
<li><a href="#supported-linux-and-bsd-distribution-releases">Supported Linux and BSD distribution releases</a></li>
<li><a href="#hardware-requirements">Hardware Requirements</a></li>
</ul>
</li>
<li><a href="#sign-up-and-login">Sign up and login</a></li>
<li><a href="#add-a-new-mail-server">Add a new mail server</a></li>
<li><a href="#choose-preferred-backend">Choose preferred backend</a></li>
<li><a href="#choose-the-components-you-want-to-deploy">Choose the components you want to deploy</a></li>
<li><a href="#component-settings">Component settings</a></li>
<li><a href="#deploy">Deploy</a></li>
<li><a href="#get-techinical-support-through-the-ticket-system">Get techinical support through the ticket system</a></li>
<li><a href="#update-account-profile">Update account profile</a></li>
<li><a href="#see-also">See Also</a></li>
</ul>
</li>
</ul>
</div>
<div class="admonition warning">
<p class="admonition-title">Warning</p>
<p>iRedMail Easy platform will be discontinued on Jan 25, 2026. <a href="https://forum.iredmail.org/topic20762.html">Get a FREE iRedMail Enterprise Edition license and migrate.</a></p>
</div>
<div class="admonition attention">
<p class="admonition-title">Attention</p>
<ul>
<li>All accounts and passwords generated during deployment are stored in
  file <code>/root/iRedMail/iRedMail.tips</code> on your server.</li>
<li>To migrate your existing iRedMail release to <strong>iRedMail Easy</strong> platform,
  please check this tutorial:
  <a href="./migrate.to.iredmail.easy.html">Migrate from iRedMail to iRedMail Easy platform</a>.</li>
</ul>
</div>
<h2 id="summary">Summary</h2>
<p><strong>iRedMail Easy</strong> is a web-based deployment and support platform.  With this
platform, it's easy to deploy and keep the iRedMail server up to date, easy to
get the fast and professional technical support from iRedMail team.</p>
<p>We encourage all users to deploy new iRedMail servers with this platform and
keep the servers up to date.</p>
<ul>
<li>Please also read <a href="./iredmail-easy.best.practice.html">Best Practice</a> to
  understand how to achieve fearless one-click upgrade with iRedMail Easy.</li>
<li>Read <a href="./iredmail-easy.release.notes.html">Release Notes</a> to track changes in
  each release.</li>
</ul>
<p>If you prefer classic downloadable iRedMail installer, you can find the
installation guides here: <a href="./index.html#install">Install iRedMail</a>.</p>
<h2 id="system-requirements">System Requirements</h2>
<div class="admonition warning">
<p class="admonition-title">Warning</p>
<ul>
<li>iRedMail is designed to be deployed on a dedicated server, which means you
  can not have other network services running on the server <strong>BEFORE</strong>
  iRedMail installation.</li>
<li>iRedMail will install and configure all required software automatically.</li>
<li>
<p>Many ISPs block port 25 by default, it's used for communication between
  mail servers, it must be open, otherwise your server may be not able to
  receive or / and send emails. Please contact your ISP to make sure it's
  not blocked, or ask them to unblock.</p>
<ul>
<li>Amazon AWS EC2. Request to <a href="https://aws.amazon.com/premiumsupport/knowledge-center/ec2-port-25-throttle/">remove the throttle on port 25</a>.</li>
<li>Google Cloud Platform.</li>
<li>Microsoft Azure.</li>
<li>Linode. Explained in the <a href="https://www.linode.com/blog/linode/a-new-policy-to-help-fight-spam/">blog post</a>,
    you can open a support ticket to request the Linode team to open it. If you <a href="https://www.linode.com/?r=b4d04083428fb99ce452d84b57253d11692a0850">sign up to Linode with our reference</a>, iRedMail Team's Linode account will receive a credit of $15-20.00. Thanks.</li>
<li>DigitalOcean. According to <a href="https://www.digitalocean.com/community/questions/port-25-465-is-blocked-how-can-i-enable-it">a post in their community</a>, <strong>SEEMS</strong> impossible to unblock port 25, that means you can <strong>NOT</strong> run mail server on DigitalOcean VPS.</li>
</ul>
</li>
</ul>
</div>
<h3 id="supported-linux-and-bsd-distribution-releases">Supported Linux and BSD distribution releases</h3>
<p>Linux/BSD distribution releases supported by <strong>iRedMail Easy</strong>:</p>
<table>
<thead>
<tr>
<th>Distribution</th>
<th>Release Versions</th>
</tr>
</thead>
<tbody>
<tr>
<td>CentOS</td>
<td>8, 9 (recommended)</td>
</tr>
<tr>
<td>Debian</td>
<td>10, 11 (recommended)</td>
</tr>
<tr>
<td>Ubuntu</td>
<td>20.04, 22.04 (recommended)</td>
</tr>
<tr>
<td>OpenBSD</td>
<td>7.3</td>
</tr>
</tbody>
</table>
<p>If you need to install iRedMail on FreeBSD, please use the <a href="https://www.iredmail.org/download.html">downloadable
installer</a> instead.</p>
<h3 id="hardware-requirements">Hardware Requirements</h3>
<ul>
<li>iRedMail requires at least <code>4 GB</code> memory for a low traffic production server.</li>
<li>If you plan to run SOGo Groupware (which offers webmail, calendar (CalDAV),
  contacts (CardDAV) and ActiveSync), you need a lot more memory. Consider 16
  GB memory to support 500 ActiveSync clients.</li>
</ul>
<h2 id="sign-up-and-login">Sign up and login</h2>
<p>To deploy a mail server, you need to sign up with a valid email
address first:</p>
<ul>
<li><a href="https://easy.iredmail.org">Sign Up or Login: https://easy.iredmail.org/</a></li>
</ul>
<p>It will send you an email to confirm you're the owner of the email address,
please click the link in the email to confirm, then login.</p>
<p>After signed up, you get one-month trial for free to evaluate the iRedMail Easy
platform, if you don't like it, or don't need it, feel free to remove your own
account in <code>Profile</code> page on the left sidebar after logged in.</p>
<p>Screenshots of Sign Up and Login pages:</p>
<p><img alt="" src="./images/iredmail-easy/installation/signup.png" width="350px" />
<img alt="" src="./images/iredmail-easy/installation/login.png" width="350px" /></p>
<h2 id="add-a-new-mail-server">Add a new mail server</h2>
<p>After login, you will be redirected to the <code>Dashboard</code> page, please click the
<code>Add a mail server</code> button to add a new mail server.</p>
<p><img alt="" src="./images/iredmail-easy/installation/add_mailserver.png" width="600px" /></p>
<p>Explanation of the form fields:</p>
<ul>
<li>
<p><code>Hostname (FQDN)</code>: This is the server hostname you want to set for the mail server.</p>
<ul>
<li>It must be a fully qualified domain name (FQDN), for example,
  <code>mail.example.com</code>, <code>mx.example.com</code>.</li>
<li>This hostname can <strong>NOT</strong> be used as a virtual mail domain (used in email
  address like <code>user@example.com</code>) because it's used to accept email sent
  to Linux/BSD system account like <code>root</code> user.</li>
</ul>
</li>
<li>
<p><code>IP Address</code>: Public or private IP address of your mail server.</p>
<p>If this mail server is in internal network and can not be accessed directly
from external network, you need a Jump Server (or, Bastion Server) so that
our deployment server can connect to your mail server. For more details
about Jump Server, please read this short tutorial: <a href="./iredmail-easy.what.is.ssh.jump.server.html">What is SSH jump
server</a>.</p>
</li>
<li>
<p><code>SSH Port</code>: SSH service port number. Defaults to 22.</p>
</li>
<li>
<p><code>SSH User</code>: The login username for ssh secure connection. Defaults to <code>root</code>.</p>
<p>If you use a non-root user, <code>sudo</code> on Linux or <code>doas</code> on OpenBSD is
required to gain root privilege.</p>
</li>
<li>
<p><code>SSH Key</code>: The SSH key used to login to your mail server.</p>
<p>If you choose option <code>Generate one for me</code>, after submitted this form,
our system will generate a strong (4096 bits) SSH key for you.</p>
</li>
<li>
<p><code>OS</code>: Choose the Linux/BSD distribution and release version of your mail
  server.</p>
</li>
<li>
<p><code>Deployment Server</code>: Please choose one deployment server from the list.</p>
<p>A deployment server connects to your mail server to deploy or upgrade,
please choose the nearest one for faster network connection.</p>
<p>If your mail server sits behind a firewall, please whitelist the IP address
of selected deployment server.</p>
</li>
<li>
<p><code>Comment</code>: Add some text to help you identify this mail server.</p>
</li>
</ul>
<p>Click the button to create mail server, after created, page will be redirected
to mail server profile page.  You're free to update profile here.</p>
<p><img alt="" src="./images/iredmail-easy/installation/added_mailserver.png" width="600px" /></p>
<h2 id="choose-preferred-backend">Choose preferred backend</h2>
<p>Click tab <code>Backend</code> on the mail server profile page.</p>
<p>A backend is a SQL or LDAP database used to store mail domains and
accounts. We suggest you choose the one you're familiar with for easier
maintenance.</p>
<p><img alt="" src="./images/iredmail-easy/installation/backends.png" width="700px" /></p>
<h2 id="choose-the-components-you-want-to-deploy">Choose the components you want to deploy</h2>
<p>Click tab <code>Components</code> on the mail server profile page.</p>
<p>A component is a software (or software group) which implements some network
service(s). On this page you can choose the components you want to deploy on
your mail server.</p>
<p><img alt="" src="./images/iredmail-easy/installation/components.png" width="700px" /></p>
<h2 id="component-settings">Component settings</h2>
<p>Click tab <code>Settings</code> on the mail server profile page.</p>
<p>Depends on the components you selected, the settings on this page may be
different. Please fill all required form fields on this page.</p>
<p>Fields with red asterisk are required, others are optional.</p>
<p><img alt="" src="./images/iredmail-easy/installation/settings.png" width="700px" /></p>
<h2 id="deploy">Deploy</h2>
<div class="admonition attention">
<p class="admonition-title">Attention</p>
<p>All accounts and passwords generated during deployment are stored in
file <code>/root/iRedMail/iRedMail.tips</code> on your server.</p>
</div>
<p>Click tab <code>Deployment</code> on the mail server profile page.</p>
<p>Please run the commands displayed on this page on your mail server, it will
download a shell script to simplify ssh public key setup. If ssh login user is
not <code>root</code>, it will help setup <code>sudo</code> (on Linux) or <code>doas</code> (on OpenBSD) also.</p>
<p><img alt="" src="./images/iredmail-easy/installation/deployment.png" width="900px" /></p>
<p>After you ran the commands, it's ready to deployment. Click the button
<code>Perform Full Deployment</code> to start the deployment.</p>
<p>Depends on the components you selected, and network connection speed between
your server and our deployment server, it may take few minutes or even longer
to finish. Please be patient.</p>
<p>It will refresh the page every 5 seconds and show you the latest output of
deployment task, you can watch and (hopefully) have some fun. :)</p>
<h2 id="get-techinical-support-through-the-ticket-system">Get techinical support through the ticket system</h2>
<p>If you have any question or issue, feel free to open a new support ticket,
clearly explain the question or issue, support team will try to reply as soon
as possible.</p>
<p><img alt="" src="./images/iredmail-easy/installation/support.png" width="600px" /></p>
<h2 id="update-account-profile">Update account profile</h2>
<p>You can update the account profile on the <code>Profile</code> page:</p>
<ul>
<li>name</li>
<li>time zone</li>
<li>password</li>
<li>subscribe to notification when new version is available</li>
</ul>
<p>If you do not like this platform, you can find a button on this page to remove
your account.</p>
<p><img alt="" src="./images/iredmail-easy/installation/account_profile.png" width="800px" /></p>
<h2 id="see-also">See Also</h2>
<ul>
<li><a href="./iredmail-easy.release.notes.html">Release notes of iRedMail Easy</a></li>
<li><a href="./iredmail-easy.best.practice.html">Best Practice</a></li>
<li><a href="./setup.dns.html">Setup DNS records for your iRedMail server</a></li>
<li><a href="./letsencrypt.html">Request a free cert from Let's Encrypt</a></li>
<li><a href="./index.html#mua">Configure mail client applications</a></li>
</ul><div class="footer">
    <p style="text-align: center; color: grey;">All documents are available in <a href="https://github.com/iredmail/docs/">GitHub repository</a>, and published under <a href="http://creativecommons.org/licenses/by-nd/3.0/us/" target="_blank">Creative Commons</a> license. You can <a href="https://github.com/iredmail/docs/archive/master.zip">download the latest version</a> for offline reading. If you found something wrong, please do <a href="https://www.iredmail.org/contact.html">contact us</a> to fix it.</p>
</div></body></html>